DOC: minor tweak to docs on invoking pypa/build #707
Conversation
|
We have several other example |
|
I think we should add |
rgommers
force-pushed
the
add-wheel-flag-to-build
branch
from
717af2c to
0e1ee55
Compare
rgommers
force-pushed
the
add-wheel-flag-to-build
branch
from
0e1ee55 to
cf6e2a7
Compare
|
@dnicolodi this is ready, CI failures were unrelated - PTAL, would be nice to merge it. |
| If the build succeeded, you'll have the binary artifacts in the ``dist`` folder. | ||
| Note that by default, ``python -m build`` builds an sdist first, and then a | ||
| wheel from the sdist. If you only want one artifact, add ``--sdist`` or | ||
| ``--wheel`` to the invocation. |
There was a problem hiding this comment.
I think that this misses the main point. The issue in not the extra work for building an sdist that will not be used, but that doing so any uncommitted change in the repository is not reflected in the wheel.
There was a problem hiding this comment.
Ah good point, will add that as the first point since it's indeed a footgun. I think both can be relevant; sdist creation for a large project can be really slow (a quick unscientific measurement says 40 seconds for scipy at the moment, and it might breaking caching on rebuilds as well).
There was a problem hiding this comment.
Added a note on uncommitted changes two paragraphs up, where it already talks about Git.
rgommers
force-pushed
the
add-wheel-flag-to-build
branch
from
cf6e2a7 to
ad68bf0
Compare
| to your Git repository - ``meson-python`` will only take into account the files | ||
| that Git knows about. | ||
| that Git knows about, and an sdist is created from the most recent commit - | ||
| uncommitted changes are ignored. |
There was a problem hiding this comment.
This paragraph is very confusing. What is committed only affects what gets into an sdist, but this section is actually about building a wheel. I think this paragraph needs to be removed and the note about uncommitted changes moved below.
There was a problem hiding this comment.
It's about both sdist and wheels. It's part of the "Creating your first release" section, and clearly does talk about both.
There was a problem hiding this comment.
I'm happy to change it to an admonition while we're at it, but I really just want to get this PR in - it was about adding the --wheel flag and not related to the commit status of files at all.
There was a problem hiding this comment.
This does not make this paragraph worse, so we can merge this PR and fix this part of the documentation later.
Addresses a comment on issue 704, where a user got tripped up by `python -m build` building an sdist first (and that's typically not what you want).
dnicolodi
force-pushed
the
add-wheel-flag-to-build
branch
from
ad68bf0 to
7ee01a1
Compare
dnicolodi
changed the title
|
I took the liberty of fixing the commit title (this does not touch how pip is invoked, thus I think the commit title was a typo) |
2 participants
Addresses a comment on gh-704, where a user got tripped up by
python -m buildbuilding an sdist first (and that's typically not what you want).